MQTTConfigOrBuilder

interface MQTTConfigOrBuilder : MessageOrBuilder

Inheritors

Functions

Link copied to clipboard
abstract fun getAddress(): String

The server to use for our MQTT global message gateway feature.
If not set, the default server will be used
string address = 2;
Link copied to clipboard
abstract fun getAddressBytes(): ByteString

The server to use for our MQTT global message gateway feature.
If not set, the default server will be used
string address = 2;
Link copied to clipboard
abstract fun getEnabled(): Boolean

If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as
is_uplink_enabled or is_downlink_enabled.
bool enabled = 1;
Link copied to clipboard

Whether to send encrypted or decrypted packets to MQTT.
This parameter is only honoured if you also set server
(the default official mqtt.meshtastic.org server can handle encrypted packets)
Decrypted packets may be useful for external systems that want to consume meshtastic packets
bool encryption_enabled = 5;
Link copied to clipboard
abstract fun getJsonEnabled(): Boolean

Whether to send / consume json packets on MQTT
bool json_enabled = 6;
Link copied to clipboard

If true, we will periodically report unencrypted information about our node to a map via MQTT
bool map_reporting_enabled = 10;
Link copied to clipboard

Settings for reporting information about our node to a map via MQTT
.meshtastic.ModuleConfig.MapReportSettings map_report_settings = 11;
Link copied to clipboard

Settings for reporting information about our node to a map via MQTT
.meshtastic.ModuleConfig.MapReportSettings map_report_settings = 11;
Link copied to clipboard
abstract fun getPassword(): String

MQTT password to use (most useful for a custom MQTT server).
If using a custom server, this will be honoured even if empty.
If using the default server, this will only be honoured if set, otherwise the device will use the default password
string password = 4;
Link copied to clipboard
abstract fun getPasswordBytes(): ByteString

MQTT password to use (most useful for a custom MQTT server).
If using a custom server, this will be honoured even if empty.
If using the default server, this will only be honoured if set, otherwise the device will use the default password
string password = 4;
Link copied to clipboard

If true, we can use the connected phone / client to proxy messages to MQTT instead of a direct connection
bool proxy_to_client_enabled = 9;
Link copied to clipboard
abstract fun getRoot(): String

The root topic to use for MQTT messages. Default is "msh".
This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs
string root = 8;
Link copied to clipboard
abstract fun getRootBytes(): ByteString

The root topic to use for MQTT messages. Default is "msh".
This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs
string root = 8;
Link copied to clipboard
abstract fun getTlsEnabled(): Boolean

If true, we attempt to establish a secure connection using TLS
bool tls_enabled = 7;
Link copied to clipboard
abstract fun getUsername(): String

MQTT username to use (most useful for a custom MQTT server).
If using a custom server, this will be honoured even if empty.
If using the default server, this will only be honoured if set, otherwise the device will use the default username
string username = 3;
Link copied to clipboard
abstract fun getUsernameBytes(): ByteString

MQTT username to use (most useful for a custom MQTT server).
If using a custom server, this will be honoured even if empty.
If using the default server, this will only be honoured if set, otherwise the device will use the default username
string username = 3;
Link copied to clipboard

Settings for reporting information about our node to a map via MQTT
.meshtastic.ModuleConfig.MapReportSettings map_report_settings = 11;